Skip to content

Revamp #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 10, 2024
Merged

Revamp #106

merged 9 commits into from
Sep 10, 2024

Conversation

blankRiot96
Copy link
Contributor

  • Changed content structure
  • Added 'what is pygame' page

Comment on lines 13 to 15
<!--
To be filled by javascript
-->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm gonna nitpick the alignment here

Comment on lines 21 to 22
pygame is "a free and open-source cross-platform library for the development
of multimedia applications like video games using Python". As the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should cite where quotes come from, in this case, it's the pygame(-ce) github readme

</p>

<p>
Pygame provides the very basic utility to draw and manipulate pixels on to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar feels off here, have a suggestion

Suggested change
Pygame provides the very basic utility to draw and manipulate pixels on to
Pygame aims to be a user-friendly library to draw and manipulate pixels onto


<p>
In this book we'll aim to cover how to do basic things with pygame, with
little exercises in between to make sure you're not falling off, goodluck
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the goodluck here seems wrong, here's an approximation of what I would prefer to see

Suggested change
little exercises in between to make sure you're not falling off, goodluck
little exercises in between to make sure you're not falling off
<b>Good Luck!</b>


<h2><a id="pygame-ce" class="js">Pygame-CE</a></h2>
<p>
So pygame currently has two major distributors, the original one and a fork
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting a sentence with "So" feels wrong, suggest opening with something different.

Suggested change
So pygame currently has two major distributors, the original one and a fork
In the event that you weren't aware, pygame currently has two major distributions, the original one and a fork

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the event that you weren't aware

I feel like this is too formal? In English it's valid to start sentences with "So" afaik. In formal writing it's frowned upon - but I was trying to go for a more friendly and engaging vibe for the whole article/book. This isn't necessarily unfriendly, of course, but I feel being too formal makes it less engaging
But if we really dont want to move forward with "So", I think we should look for an alternative as "In the event that you weren't aware" feels too formal
I'd say "In case you didn't know, " or just starting off with "Pygame has two major distributions" (but I do feel like adding "So" would be more engaging, we should poll on this maybe)

Comment on lines +141 to +148
<li>Tilemaps: Using Tiled/pytmx vs Making your own level editor</li>
<li>File structure for larger games</li>
<li>Code structure for larger games: Paradigms and Techniques</li>
<li>Utilizing OpenGL with Pygame</li>
<li>The Text Editor To Choose</li>
<li>Profiling</li>
<li>Debugging</li>
<li>Transferring code across projects</li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize each word in a title

index.html Outdated

<h2>Technical Concepts</h2>
<ul>
<li>Blend modes</li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize

index.html Outdated
<li><code>display.set_mode</code> flags</li>
<li><code>sprite</code> API</li>
<li>Audio API</li>
<li>Framerate management</li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize

index.html Outdated
Comment on lines 99 to 101
<a href="/guide/intro/chapter-8/"
>Chapter 08: The <code>pygame.draw</code> API</a
>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a href="/guide/intro/chapter-8/"
>Chapter 08: The <code>pygame.draw</code> API</a
>
<a href="/guide/intro/chapter-8/">
Chapter 08: The <code>pygame.draw</code> API
</a>

<p>
Now that you know what pygame-ce is, let's install it.

{% highlight python %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't need python syntax highlighting because it's not valid python code

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, how do I make a simple codeblock without highlighting again? Just {% highlight %}?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured it out, it was the <pre> tag

@blankRiot96 blankRiot96 merged commit 742fdcd into pygame-guide-for-sneks:revamp Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants